org.eclipse.vtp.framework.interactions.core.configurations
Class SelectionChoiceConfiguration

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.configurations.SelectionChoiceConfiguration

All Implemented Interfaces:

IConfiguration, InteractionsConstants

public class SelectionChoiceConfiguration
extends java.lang.Object
implements IConfiguration, InteractionsConstants

Configuration for a choice in a selection request interaction.

Author:

Lonnie Pryor

Field Summary

Fields inherited from interface org.eclipse.vtp.framework.interactions.core.configurations.InteractionsConstants

NAME_CHOICE, NAME_CHOICES, NAME_CONTENT_TYPE, NAME_DATA_NAME, NAME_DATA_REQUEST, NAME_FORMATTER, NAME_ID, NAME_INPUT, NAME_INPUT_ITEM, NAME_INPUT_NAME, NAME_INPUT_REQUEST, NAME_INTERACTION_TYPE, NAME_KEY, NAME_LANGUAGE, NAME_LOCALE, NAME_MEDIA, NAME_MEDIA_PROVIDER, NAME_MEDIA_PROVIDER_BINDING, NAME_META_DATA, NAME_META_DATA_ITEM, NAME_META_DATA_SET, NAME_NAME, NAME_OUTPUT, NAME_OUTPUT_ITEM, NAME_OUTPUT_MESSAGE, NAME_OUTPUT_NAME, NAME_PROPERTY, NAME_PROPERTY_ITEM, NAME_RESOURCE_MANAGER, NAME_SCRIPT, NAME_SCRIPTING_LANGUGAGE, NAME_SELECTION_REQUEST, NAME_SHARED_CONTENT, NAME_TRANSFER_MESSAGE, NAME_TYPE, NAME_VALUE, NAMESPACE_URI

Constructor Summary

SelectionChoiceConfiguration(IContentFactory contentFactory, IInputGrammarFactory inputFactory)
Creates a new SelectionChoiceConfiguration.

Method Summary

java.lang.String	getInputName() Returns the name of the input item to collect.
MediaConfiguration	getMediaConfiguration() Returns the media configuration for this message or null if no such configuration is registered.
java.lang.String	getName() Returns the name of this choice.
java.lang.String	getOutputName() Returns the name of the output item to play.
java.lang.String	getScript() Returns the script to run.
java.lang.String	getScriptingLanguage() Returns the scripting language the script is in.
void	load(org.w3c.dom.Element configurationElement) Loads the configuration information from the specified XML element.
void	save(org.w3c.dom.Element configurationElement) Saves the configuration information into the supplied XML element.
void	setInputName(java.lang.String inputName) Sets the name of the input item to collect.
void	setMediaConfiguration(MediaConfiguration mediaConfiguration) Sets the media configuration for this message.
void	setName(java.lang.String name) Sets the name of this choice.
void	setOutputName(java.lang.String outputName) Sets the name of the output item to play.
void	setScript(java.lang.String script) Sets the script to run.
void	setScriptingLanguage(java.lang.String scriptingLanguage) Sets the scripting language the script is in.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SelectionChoiceConfiguration

public SelectionChoiceConfiguration(IContentFactory contentFactory,
                                    IInputGrammarFactory inputFactory)

Creates a new SelectionChoiceConfiguration.

Parameters:

contentFactory - The content factory to use.

inputFactory - The input factory to use.

Method Detail

getName

public java.lang.String getName()

Returns the name of this choice.

Returns:

The name of this choice.

setName

public void setName(java.lang.String name)

Sets the name of this choice.

Parameters:

name - The name of this choice.

getOutputName

public java.lang.String getOutputName()

Returns the name of the output item to play.

Returns:

The name of the output item to play.

setOutputName

public void setOutputName(java.lang.String outputName)

Sets the name of the output item to play.

Parameters:

outputName - The name of the output item to play.

getInputName

public java.lang.String getInputName()

Returns the name of the input item to collect.

Returns:

The name of the input item to collect.

setInputName

public void setInputName(java.lang.String inputName)

Sets the name of the input item to collect.

Parameters:

inputName - The name of the input item to collect.

getScriptingLanguage

public java.lang.String getScriptingLanguage()

Returns the scripting language the script is in.

Returns:

The scripting language the script is in.

getScript

public java.lang.String getScript()

Returns the script to run.

Returns:

The script to run.

setScriptingLanguage

public void setScriptingLanguage(java.lang.String scriptingLanguage)

Sets the scripting language the script is in.

Parameters:

scriptingLanguage - The scripting language the script is in.

setScript

public void setScript(java.lang.String script)

Sets the script to run.

Parameters:

script - The script to run.

getMediaConfiguration

public MediaConfiguration getMediaConfiguration()

Returns the media configuration for this message or null if no such configuration is registered.

Returns:

The media configuration for this message or null if no such configuration is registered.

setMediaConfiguration

public void setMediaConfiguration(MediaConfiguration mediaConfiguration)

Sets the media configuration for this message.

Parameters:

mediaConfiguration - The media configuration for this message or null to remove the configuration.

load

public void load(org.w3c.dom.Element configurationElement)

Description copied from interface: IConfiguration

Loads the configuration information from the specified XML element.

Specified by:

load in interface IConfiguration

Parameters:

configurationElement - The element to load the configuration from.

save

public void save(org.w3c.dom.Element configurationElement)

Description copied from interface: IConfiguration

Saves the configuration information into the supplied XML element.

Specified by:

save in interface IConfiguration

Parameters:

configurationElement - The element to save the configuration to.